single_step_pre_step_routine Interface

interface
public subroutine single_step_pre_step_routine(this, prevs, sys, h, x, y, f, err)

Arguments

Type IntentOptional Attributes Name
class(single_step_integrator), intent(inout) :: this

The single_step_integrator object.

logical, intent(in) :: prevs

Defines the status of the previous step. The value is true if the previous step was successful; else, false if the previous step failed.

class(ode_container), intent(inout) :: sys

The ode_container object containing the ODE's to integrate.

real(kind=real64), intent(in) :: h

The current step size.

real(kind=real64), intent(in) :: x

The current value of the independent variable.

real(kind=real64), intent(in), dimension(:) :: y

An N-element array containing the current solution at x.

real(kind=real64), intent(in), dimension(:) :: f

An N-element array containing the values of the derivatives at x.

class(errors), intent(inout), optional, target :: err

An optional errors-based object that if provided can be used to retrieve information relating to any errors encountered during execution. If not provided, a default implementation of the errors class is used internally to provide error handling.

Description

Provides a routine for performing any actions, such as setting up Jacobian calculations.